

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Index &mdash; bitstring documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '2.0.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="bitstring documentation" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             accesskey="I">index</a></li>
        <li><a href="index.html">bitstring</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            

   <h1 id="index">Index</h1>

   <div class="genindex-jumpbox">
   <a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#J"><strong>J</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> 
   </div>
<h2 id="_">_</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.__add__">__add__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__and__">__and__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__bool__">__bool__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__contains__">__contains__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__copy__">__copy__() (bitstring.Bits method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__delitem__">__delitem__() (bitstring.BitString method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__eq__">__eq__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__getitem__">__getitem__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__hash__">__hash__() (bitstring.Bits method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__iadd__">__iadd__() (bitstring.BitString method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__iand__">__iand__() (bitstring.BitString method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__ilshift__">__ilshift__() (bitstring.BitString method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__imul__">__imul__() (bitstring.BitString method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__invert__">__invert__() (bitstring.Bits method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__ior__">__ior__() (bitstring.BitString method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__irshift__">__irshift__() (bitstring.BitString method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__ixor__">__ixor__() (bitstring.BitString method)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.__len__">__len__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__lshift__">__lshift__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__mul__">__mul__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__ne__">__ne__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__nonzero__">__nonzero__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__or__">__or__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__radd__">__radd__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__rand__">__rand__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__repr__">__repr__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__rmul__">__rmul__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__ror__">__ror__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__rshift__">__rshift__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__rxor__">__rxor__() (bitstring.Bits method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.__setitem__">__setitem__() (bitstring.BitString method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__str__">__str__() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.__xor__">__xor__() (bitstring.Bits method)</a></dt>
</dl></td>
</tr></table>

<h2 id="A">A</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.all">all() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.any">any() (bitstring.Bits method)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bitstring.html#bitstring.BitString.append">append() (bitstring.BitString method)</a></dt>
</dl></td>
</tr></table>

<h2 id="B">B</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.bin">bin (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.bin">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.bitpos">bitpos (bitstring.Bits attribute)</a></dt>
    <dt><a href="bits.html#bitstring.Bits">Bits (class in bitstring)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString">BitString (class in bitstring)</a></dt>
    <dt><a href="bitstring_classes.html#module-bitstring">bitstring (module)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.bool">bool (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.bool">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.bytealign">bytealign() (bitstring.Bits method)</a></dt>
    <dt><a href="functions.html#bitstring.ByteAlignError">ByteAlignError</a></dt>
    <dt><a href="bits.html#bitstring.Bits.bytepos">bytepos (bitstring.Bits attribute)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.bytes">bytes (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.bytes">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bitstring.html#bitstring.BitString.byteswap">byteswap() (bitstring.BitString method)</a></dt>
</dl></td>
</tr></table>

<h2 id="C">C</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.count">count() (bitstring.Bits method)</a></dt>
    <dt><a href="functions.html#bitstring.CreationError">CreationError</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.cut">cut() (bitstring.Bits method)</a></dt>
</dl></td>
</tr></table>

<h2 id="E">E</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.endswith">endswith() (bitstring.Bits method)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="functions.html#bitstring.Error">Error</a></dt>
</dl></td>
</tr></table>

<h2 id="F">F</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.find">find() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.findall">findall() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.float">float (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.float">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.floatbe">floatbe (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.floatbe">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.floatle">floatle (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.floatle">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.floatne">floatne (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.floatne">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="H">H</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.hex">hex (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.hex">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
</dl></td>
</tr></table>

<h2 id="I">I</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bitstring.html#bitstring.BitString.insert">insert() (bitstring.BitString method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.int">int (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.int">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.intbe">intbe (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.intbe">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="functions.html#bitstring.InterpretError">InterpretError</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.intle">intle (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.intle">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.intne">intne (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.intne">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bitstring.html#bitstring.BitString.invert">invert() (bitstring.BitString method)</a></dt>
</dl></td>
</tr></table>

<h2 id="J">J</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.join">join() (bitstring.Bits method)</a></dt>
</dl></td>
</tr></table>

<h2 id="L">L</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.len">len (bitstring.Bits attribute)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.length">length (bitstring.Bits attribute)</a></dt>
</dl></td>
</tr></table>

<h2 id="O">O</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.oct">oct (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.oct">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bitstring.html#bitstring.BitString.overwrite">overwrite() (bitstring.BitString method)</a></dt>
</dl></td>
</tr></table>

<h2 id="P">P</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="functions.html#bitstring.pack">pack() (in module bitstring)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.peek">peek() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.peeklist">peeklist() (bitstring.Bits method)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.pos">pos (bitstring.Bits attribute)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.prepend">prepend() (bitstring.BitString method)</a></dt>
</dl></td>
</tr></table>

<h2 id="R">R</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.read">read() (bitstring.Bits method)</a></dt>
    <dt><a href="functions.html#bitstring.ReadError">ReadError</a></dt>
    <dt><a href="bits.html#bitstring.Bits.readlist">readlist() (bitstring.Bits method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.replace">replace() (bitstring.BitString method)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bitstring.html#bitstring.BitString.reverse">reverse() (bitstring.BitString method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.rfind">rfind() (bitstring.Bits method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.rol">rol() (bitstring.BitString method)</a></dt>
    <dt><a href="bitstring.html#bitstring.BitString.ror">ror() (bitstring.BitString method)</a></dt>
</dl></td>
</tr></table>

<h2 id="S">S</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.se">se (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.se">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bitstring.html#bitstring.BitString.set">set() (bitstring.BitString method)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.split">split() (bitstring.Bits method)</a></dt>
    <dt><a href="bits.html#bitstring.Bits.startswith">startswith() (bitstring.Bits method)</a></dt>
</dl></td>
</tr></table>

<h2 id="T">T</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.tobytes">tobytes() (bitstring.Bits method)</a></dt>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.tofile">tofile() (bitstring.Bits method)</a></dt>
</dl></td>
</tr></table>

<h2 id="U">U</h2>
<table width="100%" class="indextable genindextable"><tr>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.ue">ue (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.ue">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.uint">uint (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.uint">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.uintbe">uintbe (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.uintbe">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
</dl></td>
  <td width="33%" valign="top"><dl>
    <dt><a href="bits.html#bitstring.Bits.uintle">uintle (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.uintle">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.uintne">uintne (bitstring.Bits attribute)</a></dt>
    <dd><dl>
      <dt><a href="bitstring.html#bitstring.BitString.uintne">(bitstring.BitString attribute)</a></dt>
  </dl></dd>
    <dt><a href="bits.html#bitstring.Bits.unpack">unpack() (bitstring.Bits method)</a></dt>
</dl></td>
</tr></table>



          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/bitstring_logo_small.png" alt="Logo"/>
            </a></p>

   

<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="#" title="General Index"
             >index</a></li>
        <li><a href="index.html">bitstring</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2010, Scott Griffiths.
    </div>
  </body>
</html>